package com.nanhai.buddhist.college.module.study.service.classclockrecord;

import com.nanhai.buddhist.college.framework.common.pojo.PageResult;
import com.nanhai.buddhist.college.module.study.controller.admin.classclockrecord.vo.ClockRecordCreateReqVO;
import com.nanhai.buddhist.college.module.study.controller.admin.classclockrecord.vo.ClockRecordExportReqVO;
import com.nanhai.buddhist.college.module.study.controller.admin.classclockrecord.vo.ClockRecordPageReqVO;
import com.nanhai.buddhist.college.module.study.controller.admin.classclockrecord.vo.ClockRecordTodayReqVO;
import com.nanhai.buddhist.college.module.study.controller.admin.classclockrecord.vo.ClockRecordUpdateReqVO;
import com.nanhai.buddhist.college.module.study.controller.admin.classclockrecord.vo.ClockRecordUserReqVO;
import com.nanhai.buddhist.college.module.study.controller.admin.classclockrecord.vo.ScanCodeClockReqVO;
import com.nanhai.buddhist.college.module.study.controller.student.attendance.vo.StudentClockRecordPageReqVO;
import com.nanhai.buddhist.college.module.study.controller.teacher.vo.BatchAddClockRecordReqVO;
import com.nanhai.buddhist.college.module.study.controller.teacher.vo.StudentClockListReqVO;
import com.nanhai.buddhist.college.module.study.controller.teacher.vo.SubjectStudentClockResVO;
import com.nanhai.buddhist.college.module.study.dal.dataobject.classclockrecord.ClockRecordDO;
import org.springframework.validation.annotation.Validated;

import javax.validation.Valid;
import java.util.Collection;
import java.util.List;

/**
 * 打卡记录 Service 接口
 *
 * @author AKai
 */
public interface ClockRecordService {

    /**
     * 创建打卡记录
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    String createClockRecord(@Valid ClockRecordCreateReqVO createReqVO);

    /**
     * 更新打卡记录
     *
     * @param updateReqVO 更新信息
     */
    void updateClockRecord(@Valid ClockRecordUpdateReqVO updateReqVO);

    /**
     * 删除打卡记录
     *
     * @param id 编号
     */
    void deleteClockRecord(String id);

    /**
     * 获得打卡记录
     *
     * @param id 编号
     * @return 打卡记录
     */
    ClockRecordDO getClockRecord(String id);

    /**
     * 获得打卡记录列表
     *
     * @param ids 编号
     * @return 打卡记录列表
     */
    List<ClockRecordDO> getClockRecordList(Collection<String> ids);

    /**
     * 获得打卡记录分页
     *
     * @param pageReqVO 分页查询
     * @return 打卡记录分页
     */
    PageResult<ClockRecordDO> getClockRecordPage(ClockRecordPageReqVO pageReqVO);

    /**
     * 获得打卡记录列表, 用于 Excel 导出
     *
     * @param exportReqVO 查询条件
     * @return 打卡记录列表
     */
    List<ClockRecordDO> getClockRecordList(ClockRecordExportReqVO exportReqVO);

    /**
     * 批量打卡
     *
     * @param batchAddClockRecordReqVO
     */
    void batchAddClockRecord(BatchAddClockRecordReqVO batchAddClockRecordReqVO);


    /**
     * 学生端 分页获取打卡记录
     */
    PageResult<ClockRecordDO> getStudentClockRecordPage(StudentClockRecordPageReqVO pageVO);

    /**
     * 获取今日打卡记录
     *
     * @param recordTodayReqVO
     * @return
     */
    List<ClockRecordDO> getTodayClock( ClockRecordTodayReqVO recordTodayReqVO);

    /**
     * 根据课程id 获取打卡记录
     * @param reqVO
     * @return
     */
    List<ClockRecordDO> getTodayClockBySubjectId( ClockRecordUserReqVO reqVO);

    String scanCodeClock(ScanCodeClockReqVO codeClockReqVO);

    /**
     * 课程 学生的打卡
     * @param reqVO
     * @return
     */
    List<SubjectStudentClockResVO> getStudentClockList(StudentClockListReqVO reqVO);


}
